Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: more documentation about Rules #2014

Merged
merged 1 commit into from
Jul 14, 2024
Merged

doc: more documentation about Rules #2014

merged 1 commit into from
Jul 14, 2024

Conversation

CatHood0
Copy link
Collaborator

Description

I added some more documentation of what the Rules are within the editor and how they work (according to what I could understand). In addition to providing an example of a custom rule for anyone who wishes to have an example of a Rule that is not the default in the package.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I titled the PR using Conventional Commits.
  • I did not modify the CHANGELOG.md nor the package version in pubspec.yaml files.
  • All existing and new tests are passing.
  • I have run the commands in ./scripts/before_push.sh and it all passed successfully

Breaking Change

Does your PR require developers to manually update their apps to accommodate your change?

  • Yes, this is a breaking change (please indicate that with a ! in the title as explained in Conventional Commits).
  • No, this is not a breaking change.

@CatHood0 CatHood0 requested a review from EchoEllet July 14, 2024 21:06
@CatHood0 CatHood0 changed the title Doc(Rule): more documentation about Rules Added more documentation about Rules Jul 14, 2024
@CatHood0 CatHood0 changed the title Added more documentation about Rules doc: more documentation about Rules Jul 14, 2024
@singerdmx singerdmx merged commit 7282e72 into singerdmx:master Jul 14, 2024
2 checks passed
@CatHood0 CatHood0 deleted the rules_documentation branch July 16, 2024 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants